Repository navigation
Add update-docs skill for writing docs against the live Glific app - #685
Draft
rvignesh89 wants to merge 6 commits into
Draft
rvignesh89 wants to merge 6 commits into
rvignesh89 wants to merge 6 commits into
Conversation
/update-docs writes, refreshes, reviews and restructures docs against the live Glific app from a cloud env with playwright-cli preinstalled. - gdocs.mjs (zero-dep): preflight (env, CLI, browser, guard canary, redaction self-test, login), guarded session, redacted screenshots, blocked-write log, provenance/link lint - Network guard blocks mutations, lock-taking queries (flowGet, simulatorGet) and non-GET REST writes before login - Bash hooks restrict direct playwright-cli use to the guarded session and surface blocked writes so Claude stops and warns Co-Authored-By: Claude Opus 5.5 <[email protected]>
Move sections, style-writing, style-page and style-images into update-docs and remove the old documentation skill. - Header guidance now matches the <h3><table> block with Last Updated that most pages use, instead of the legacy ###** badge - Image guide requires gdocs shot; adds framing and filename-stability rules - Sections: _category_.json generated-index (not index.md), more routes - Refresh workflow accepts a glific-frontend PR as input Co-Authored-By: Claude Opus 5.5 <[email protected]>
Document the new Messages Overview tab (Messages Exchanged card, service message billing notice, Message Composition chart) and replace the intro screenshot with one showing all four tabs. Co-Authored-By: Claude Opus 5.5 <[email protected]> Claude-Session: https://claude.ai/code/session_01YZEqcwqazipcxQbcraCE5G
Keep this branch to the update-docs skill changes only. This reverts commit ff469fe. Co-Authored-By: Claude Opus 5.5 <[email protected]> Claude-Session: https://claude.ai/code/session_01YZEqcwqazipcxQbcraCE5G
Contributor
|
Important Draft PR not reviewedDraft PRs are not automatically reviewed by default.
To automatically review draft PRs, update your CodeRabbit configuration: reviews:
auto_review:
drafts: true
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
🚀 Deployed on https://deploy-preview-685--glific-docs.netlify.app |
The guard now lets flowGet (without isForced) and flowRelease through so the flow editor can be documented. Everything else stays blocked: Take Over (flowGet isForced), simulatorGet/Release, all mutations and autosaved revisions. Allowed lock events are logged separately from blocked ones; gdocs blocked flags a held lock and gdocs stop releases it by loading the flow list. safety.md gains flow editor rules. Co-Authored-By: Claude Opus 5.5 <[email protected]>
gdocs.mjs -> glific-browser.mjs, pw-guard-hook.sh -> browser-guard-hook.sh. Hook paths in .claude/settings.json and all skill docs updated. Co-Authored-By: Claude Opus 5.5 <[email protected]>
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds the
update-docsClaude Code skill (/update-docs). It writes, refreshes, reviews and restructures Glific docs. It checks the live production Glific app through a read-onlyplaywright-clibrowser session that redacts personal data from screenshots. It replaces the olddocumentationskill.Skill:
.claude/skills/update-docs/scripts/gdocs.mjshas no dependencies and does the following:preflightchecks the env vars, the CLI, the browser launch, a guard canary (a test write that must be blocked), a redaction self-test, and the login.shottakes redacted screenshots and records their hashes in a manifest.blockedlists write requests the guard stopped.lintchecks image provenance,/img/refs and.mdlinks.flowGet,flowRelease,simulatorGet,simulatorRelease).scripts/pw-guard-hook.sh(Bash pre/post hooks):playwright-clicalls must use the guarded session and an allow-listed set of commands.browsing.mdandsafety.md.Style guides moved over from the old
documentationskillsections,style-writing,style-pageandstyle-imagesnow live inupdate-docs, and.claude/skills/documentation/is removed.<table>block with Last Updated that most pages use.gdocs shotand adds rules for framing and keeping filenames stable.Other
.gitignore: ignore.playwright-cli/(session output, snapshots, redaction manifest).Notes
maincontains only the skill.GLIFIC_URL,GLIFIC_PHONE,GLIFIC_PASSWORD,playwright-cliwith a matching Chromium, andmoonshine.projecttech4dev.orgin the allowed domains so the analytics dashboard loads.🤖 Generated with Claude Code
https://claude.ai/code/session_01YZEqcwqazipcxQbcraCE5G
Generated by Claude Code